/*
 * PROJECT:     ReactOS headers
 * LICENSE:     LGPL-2.1-or-later (https://spdx.org/licenses/LGPL-2.1-or-later)
 * PURPOSE:     Declarations for IMM32
 * COPYRIGHT:   Copyright (C) the Wine project
 *              Copyright (C) 2021-2024 Katayama Hirofumi MZ <katayama.hirofumi.mz@gmail.com>
 */

#ifndef __WINE_IMM_H
#define __WINE_IMM_H

#ifdef __cplusplus
extern "C" {
#endif

#if (WINVER >= 0x040A)
DECLARE_HANDLE(HIMC);
DECLARE_HANDLE(HIMCC);
#else
typedef DWORD HIMC;
typedef DWORD HIMCC;
#endif

typedef HKL FAR *LPHKL;
typedef UINT FAR *LPUINT;

typedef struct tagREGISTERWORDA {
    LPSTR lpReading;
    LPSTR lpWord;
} REGISTERWORDA, *PREGISTERWORDA, NEAR *NPREGISTERWORDA, FAR *LPREGISTERWORDA;

typedef struct tagREGISTERWORDW {
    LPWSTR lpReading;
    LPWSTR lpWord;
} REGISTERWORDW, *PREGISTERWORDW, NEAR *NPREGISTERWORDW, FAR *LPREGISTERWORDW;

typedef INT (CALLBACK *REGISTERWORDENUMPROCA)(
    _In_ LPCSTR lpszReading,
    _In_ DWORD dwStyle,
    _In_ LPCSTR lpszRegister,
    _Inout_opt_ LPVOID lpData);

typedef INT (CALLBACK *REGISTERWORDENUMPROCW)(
    _In_ LPCWSTR lpszReading,
    _In_ DWORD dwStyle,
    _In_ LPCWSTR lpszRegister,
    _Inout_opt_ LPVOID lpData);

typedef struct tagCANDIDATEFORM {
    DWORD dwIndex;
    DWORD dwStyle;
    POINT ptCurrentPos;
    RECT  rcArea;
} CANDIDATEFORM, *PCANDIDATEFORM, NEAR *NPCANDIDATEFORM, FAR *LPCANDIDATEFORM;

typedef struct tagCANDIDATELIST {
    DWORD dwSize;
    DWORD dwStyle;
    DWORD dwCount;
    DWORD dwSelection;
    DWORD dwPageStart;
    DWORD dwPageSize;
    DWORD dwOffset[ANYSIZE_ARRAY];
} CANDIDATELIST, *PCANDIDATELIST, NEAR *NPCANDIDATELIST, FAR *LPCANDIDATELIST;

#define STYLE_DESCRIPTION_SIZE 32

typedef struct tagSTYLEBUFA {
    DWORD dwStyle;
    CHAR  szDescription[STYLE_DESCRIPTION_SIZE];
} STYLEBUFA, *PSTYLEBUFA, NEAR *NPSTYLEBUFA, FAR *LPSTYLEBUFA;

typedef struct tagSTYLEBUFW {
    DWORD dwStyle;
    WCHAR  szDescription[STYLE_DESCRIPTION_SIZE];
} STYLEBUFW, *PSTYLEBUFW, NEAR *NPSTYLEBUFW, FAR *LPSTYLEBUFW;

#if (WINVER >= 0x040A)

typedef struct tagRECONVERTSTRING {
    DWORD dwSize;
    DWORD dwVersion;
    DWORD dwStrLen;
    DWORD dwStrOffset;
    DWORD dwCompStrLen;
    DWORD dwCompStrOffset;
    DWORD dwTargetStrLen;
    DWORD dwTargetStrOffset;
} RECONVERTSTRING, *PRECONVERTSTRING, NEAR *NPRECONVERTSTRING, FAR *LPRECONVERTSTRING;

#define IMEMENUITEM_STRING_SIZE 80

typedef struct tagIMEMENUITEMINFOA {
    UINT        cbSize;
    UINT        fType;
    UINT        fState;
    UINT        wID;
    HBITMAP     hbmpChecked;
    HBITMAP     hbmpUnchecked;
    DWORD       dwItemData;
    CHAR        szString[IMEMENUITEM_STRING_SIZE];
    HBITMAP     hbmpItem;
} IMEMENUITEMINFOA, *PIMEMENUITEMINFOA, NEAR *NPIMEMENUITEMINFOA, FAR *LPIMEMENUITEMINFOA;

typedef struct tagIMEMENUITEMINFOW {
    UINT        cbSize;
    UINT        fType;
    UINT        fState;
    UINT        wID;
    HBITMAP     hbmpChecked;
    HBITMAP     hbmpUnchecked;
    DWORD       dwItemData;
    WCHAR       szString[IMEMENUITEM_STRING_SIZE];
    HBITMAP     hbmpItem;
} IMEMENUITEMINFOW, *PIMEMENUITEMINFOW, NEAR *NPIMEMENUITEMINFOW, FAR *LPIMEMENUITEMINFOW;

#ifdef UNICODE
    typedef IMEMENUITEMINFOW IMEMENUITEMINFO;
    typedef PIMEMENUITEMINFOW PIMEMENUITEMINFO;
    typedef NPIMEMENUITEMINFOW NPIMEMENUITEMINFO;
    typedef LPIMEMENUITEMINFOW LPIMEMENUITEMINFO;
#else
    typedef IMEMENUITEMINFOA IMEMENUITEMINFO;
    typedef PIMEMENUITEMINFOA PIMEMENUITEMINFO;
    typedef NPIMEMENUITEMINFOA NPIMEMENUITEMINFO;
    typedef LPIMEMENUITEMINFOA LPIMEMENUITEMINFO;
#endif

typedef struct tagIMECHARPOSITION {
    DWORD       dwSize;
    DWORD       dwCharPos;
    POINT       pt;
    UINT        cLineHeight;
    RECT        rcDocument;
} IMECHARPOSITION, *PIMECHARPOSITION, *NPIMECHARPOSITION, *LPIMECHARPOSITION;

typedef BOOL (CALLBACK *IMCENUMPROC)(_In_ HIMC hIMC, _In_ LPARAM lParam);

#endif /* WINVER >= 0x040A */

typedef struct _tagCOMPOSITIONFORM {
    DWORD   dwStyle;
    POINT ptCurrentPos;
    RECT  rcArea;
} COMPOSITIONFORM, *PCOMPOSITIONFORM, NEAR *NPCOMPOSITIONFORM, FAR *LPCOMPOSITIONFORM;

/* wParam for WM_IME_CONTROL */
#define IMC_GETCANDIDATEPOS             0x0007
#define IMC_SETCANDIDATEPOS             0x0008
#define IMC_GETCOMPOSITIONFONT          0x0009
#define IMC_SETCOMPOSITIONFONT          0x000A
#define IMC_GETCOMPOSITIONWINDOW        0x000B
#define IMC_SETCOMPOSITIONWINDOW        0x000C
#define IMC_GETSTATUSWINDOWPOS          0x000F
#define IMC_SETSTATUSWINDOWPOS          0x0010
#define IMC_CLOSESTATUSWINDOW           0x0021
#define IMC_OPENSTATUSWINDOW            0x0022

/* dwAction for ImmNotifyIME  */
#define NI_OPENCANDIDATE                0x0010
#define NI_CLOSECANDIDATE               0x0011
#define NI_SELECTCANDIDATESTR           0x0012
#define NI_CHANGECANDIDATELIST          0x0013
#define NI_FINALIZECONVERSIONRESULT     0x0014
#define NI_COMPOSITIONSTR               0x0015
#define NI_SETCANDIDATE_PAGESTART       0x0016
#define NI_SETCANDIDATE_PAGESIZE        0x0017
#define NI_IMEMENUSELECTED              0x0018

/* lParam for WM_IME_SETCONTEXT */
#define ISC_SHOWUICANDIDATEWINDOW       0x00000001
#define ISC_SHOWUICOMPOSITIONWINDOW     0x80000000
#define ISC_SHOWUIGUIDELINE             0x40000000
#define ISC_SHOWUIALLCANDIDATEWINDOW    0x0000000F
#define ISC_SHOWUIALL                   0xC000000F

/* dwIndex for ImmNotifyIME/NI_COMPOSITIONSTR */
#define CPS_COMPLETE                    0x0001
#define CPS_CONVERT                     0x0002
#define CPS_REVERT                      0x0003
#define CPS_CANCEL                      0x0004

/* the modifiers of hot key */
#define MOD_ALT                         0x0001
#define MOD_CONTROL                     0x0002
#define MOD_SHIFT                       0x0004

#define MOD_LEFT                        0x8000
#define MOD_RIGHT                       0x4000

#define MOD_ON_KEYUP                    0x0800
#define MOD_IGNORE_ALL_MODIFIER         0x0400

/* Windows for Simplified Chinese Edition hot key ID from 0x10 - 0x2F */
#define IME_CHOTKEY_IME_NONIME_TOGGLE           0x10
#define IME_CHOTKEY_SHAPE_TOGGLE                0x11
#define IME_CHOTKEY_SYMBOL_TOGGLE               0x12

/* Windows for Japanese Edition hot key ID from 0x30 - 0x4F */
#define IME_JHOTKEY_CLOSE_OPEN                  0x30

/* Windows for Korean Edition hot key ID from 0x50 - 0x6F */
#define IME_KHOTKEY_SHAPE_TOGGLE                0x50
#define IME_KHOTKEY_HANJACONVERT                0x51
#define IME_KHOTKEY_ENGLISH                     0x52
/* Windows for Tranditional Chinese Edition hot key ID from 0x70 - 0x8F */
#define IME_THOTKEY_IME_NONIME_TOGGLE           0x70
#define IME_THOTKEY_SHAPE_TOGGLE                0x71
#define IME_THOTKEY_SYMBOL_TOGGLE               0x72

/* direct switch hot key ID from 0x100 - 0x11F */
#define IME_HOTKEY_DSWITCH_FIRST                0x100
#define IME_HOTKEY_DSWITCH_LAST                 0x11F

/* IME private hot key from 0x200 - 0x21F */
#define IME_HOTKEY_PRIVATE_FIRST                0x200
#define IME_ITHOTKEY_RESEND_RESULTSTR           0x200
#define IME_ITHOTKEY_PREVIOUS_COMPOSITION       0x201
#define IME_ITHOTKEY_UISTYLE_TOGGLE             0x202
#define IME_ITHOTKEY_RECONVERTSTRING            0x203
#define IME_HOTKEY_PRIVATE_LAST                 0x21F

/* parameter of ImmGetCompositionString */
#define GCS_COMPREADSTR                 0x0001
#define GCS_COMPREADATTR                0x0002
#define GCS_COMPREADCLAUSE              0x0004
#define GCS_COMPSTR                     0x0008
#define GCS_COMPATTR                    0x0010
#define GCS_COMPCLAUSE                  0x0020
#define GCS_CURSORPOS                   0x0080
#define GCS_DELTASTART                  0x0100
#define GCS_RESULTREADSTR               0x0200
#define GCS_RESULTREADCLAUSE            0x0400
#define GCS_RESULTSTR                   0x0800
#define GCS_RESULTCLAUSE                0x1000

/* style bit flags for WM_IME_COMPOSITION */
#define CS_INSERTCHAR                   0x2000
#define CS_NOMOVECARET                  0x4000

/* IME version constants */
#define IMEVER_0310                     0x0003000A
#define IMEVER_0400                     0x00040000

/* IME property bits */
#define IME_PROP_AT_CARET               0x00010000
#define IME_PROP_SPECIAL_UI             0x00020000
#define IME_PROP_CANDLIST_START_FROM_1  0x00040000
#define IME_PROP_UNICODE                0x00080000
#define IME_PROP_COMPLETE_ON_UNSELECT   0x00100000

/* IME UICapability bits */
#define UI_CAP_2700                     0x00000001
#define UI_CAP_ROT90                    0x00000002
#define UI_CAP_ROTANY                   0x00000004
#define UI_CAP_SOFTKBD                  0x00010000

/* ImmSetCompositionString Capability bits */
#define SCS_CAP_COMPSTR                 0x00000001
#define SCS_CAP_MAKEREAD                0x00000002
#define SCS_CAP_SETRECONVERTSTRING      0x00000004

/* IME WM_IME_SELECT inheritance Capability bits */
#define SELECT_CAP_CONVERSION           0x00000001
#define SELECT_CAP_SENTENCE             0x00000002

/* ID for dwIndex of ImmGetGuideLine */
#define GGL_LEVEL                       0x00000001
#define GGL_INDEX                       0x00000002
#define GGL_STRING                      0x00000003
#define GGL_PRIVATE                     0x00000004

/* ID for dwLevel of GUIDELINE Structure */
#define GL_LEVEL_NOGUIDELINE            0x00000000
#define GL_LEVEL_FATAL                  0x00000001
#define GL_LEVEL_ERROR                  0x00000002
#define GL_LEVEL_WARNING                0x00000003
#define GL_LEVEL_INFORMATION            0x00000004

/* ID for dwIndex of GUIDELINE Structure */
#define GL_ID_UNKNOWN                   0x00000000
#define GL_ID_NOMODULE                  0x00000001
#define GL_ID_NODICTIONARY              0x00000010
#define GL_ID_CANNOTSAVE                0x00000011
#define GL_ID_NOCONVERT                 0x00000020
#define GL_ID_TYPINGERROR               0x00000021
#define GL_ID_TOOMANYSTROKE             0x00000022
#define GL_ID_READINGCONFLICT           0x00000023
#define GL_ID_INPUTREADING              0x00000024
#define GL_ID_INPUTRADICAL              0x00000025
#define GL_ID_INPUTCODE                 0x00000026
#define GL_ID_INPUTSYMBOL               0x00000027
#define GL_ID_CHOOSECANDIDATE           0x00000028
#define GL_ID_REVERSECONVERSION         0x00000029
#define GL_ID_PRIVATE_FIRST             0x00008000
#define GL_ID_PRIVATE_LAST              0x0000FFFF

/* ID for dwIndex of ImmGetProperty */
#define IGP_GETIMEVERSION               (DWORD)(-4)
#define IGP_PROPERTY                    0x00000004
#define IGP_CONVERSION                  0x00000008
#define IGP_SENTENCE                    0x0000000C
#define IGP_UI                          0x00000010
#define IGP_SETCOMPSTR                  0x00000014
#define IGP_SELECT                      0x00000018

/* dwIndex for ImmSetCompositionString API */
#define SCS_SETSTR                      (GCS_COMPREADSTR | GCS_COMPSTR)
#define SCS_CHANGEATTR                  (GCS_COMPREADATTR | GCS_COMPATTR)
#define SCS_CHANGECLAUSE                (GCS_COMPREADCLAUSE | GCS_COMPCLAUSE)
#define SCS_SETRECONVERTSTRING          0x00010000
#define SCS_QUERYRECONVERTSTRING        0x00020000

/* attribute for COMPOSITIONSTRING Structure */
#define ATTR_INPUT                      0x00
#define ATTR_TARGET_CONVERTED           0x01
#define ATTR_CONVERTED                  0x02
#define ATTR_TARGET_NOTCONVERTED        0x03
#define ATTR_INPUT_ERROR                0x04
#define ATTR_FIXEDCONVERTED             0x05

/* bit field for IMC_SETCOMPOSITIONWINDOW, IMC_SETCANDIDATEWINDOW */
#define CFS_DEFAULT                     0x0000
#define CFS_RECT                        0x0001
#define CFS_POINT                       0x0002
#define CFS_FORCE_POSITION              0x0020
#define CFS_CANDIDATEPOS                0x0040
#define CFS_EXCLUDE                     0x0080

/* conversion direction for ImmGetConversionList */
#define GCL_CONVERSION                  0x0001
#define GCL_REVERSECONVERSION           0x0002
#define GCL_REVERSE_LENGTH              0x0003

/* bit field for conversion mode */
#define IME_CMODE_ALPHANUMERIC          0x0000
#define IME_CMODE_NATIVE                0x0001
#define IME_CMODE_CHINESE               IME_CMODE_NATIVE
/* IME_CMODE_HANGEUL is old name of IME_CMODE_HANGUL. It will be gone eventually. */
#define IME_CMODE_HANGEUL               IME_CMODE_NATIVE
#define IME_CMODE_HANGUL                IME_CMODE_NATIVE
#define IME_CMODE_JAPANESE              IME_CMODE_NATIVE
#define IME_CMODE_KATAKANA              0x0002  /* only effect under IME_CMODE_NATIVE */
#define IME_CMODE_LANGUAGE              0x0003
#define IME_CMODE_FULLSHAPE             0x0008
#define IME_CMODE_ROMAN                 0x0010
#define IME_CMODE_CHARCODE              0x0020
#define IME_CMODE_HANJACONVERT          0x0040
#define IME_CMODE_SOFTKBD               0x0080
#define IME_CMODE_NOCONVERSION          0x0100
#define IME_CMODE_EUDC                  0x0200
#define IME_CMODE_SYMBOL                0x0400
#define IME_CMODE_FIXED                 0x0800

/* bit field for sentence mode */
#define IME_SMODE_NONE                  0x0000
#define IME_SMODE_PLAURALCLAUSE         0x0001
#define IME_SMODE_SINGLECONVERT         0x0002
#define IME_SMODE_AUTOMATIC             0x0004
#define IME_SMODE_PHRASEPREDICT         0x0008
#define IME_SMODE_CONVERSATION          0x0010

/* style of candidate */
#define IME_CAND_UNKNOWN                0x0000
#define IME_CAND_READ                   0x0001
#define IME_CAND_CODE                   0x0002
#define IME_CAND_MEANING                0x0003
#define IME_CAND_RADICAL                0x0004
#define IME_CAND_STROKE                 0x0005

/* wParam of report message WM_IME_NOTIFY */
#define IMN_CLOSESTATUSWINDOW           0x0001
#define IMN_OPENSTATUSWINDOW            0x0002
#define IMN_CHANGECANDIDATE             0x0003
#define IMN_CLOSECANDIDATE              0x0004
#define IMN_OPENCANDIDATE               0x0005
#define IMN_SETCONVERSIONMODE           0x0006
#define IMN_SETSENTENCEMODE             0x0007
#define IMN_SETOPENSTATUS               0x0008
#define IMN_SETCANDIDATEPOS             0x0009
#define IMN_SETCOMPOSITIONFONT          0x000A
#define IMN_SETCOMPOSITIONWINDOW        0x000B
#define IMN_SETSTATUSWINDOWPOS          0x000C
#define IMN_GUIDELINE                   0x000D
#define IMN_PRIVATE                     0x000E

#if (WINVER >= 0x040A)

/* wParam of report message WM_IME_REQUEST */
#define IMR_COMPOSITIONWINDOW           0x0001
#define IMR_CANDIDATEWINDOW             0x0002
#define IMR_COMPOSITIONFONT             0x0003
#define IMR_RECONVERTSTRING             0x0004
#define IMR_CONFIRMRECONVERTSTRING      0x0005
#define IMR_QUERYCHARPOSITION           0x0006
#define IMR_DOCUMENTFEED                0x0007

#endif

/* error code of ImmGetCompositionString */
#define IMM_ERROR_NODATA                (-1)
#define IMM_ERROR_GENERAL               (-2)

/* dialog mode of ImmConfigureIME */
#define IME_CONFIG_GENERAL              1
#define IME_CONFIG_REGISTERWORD         2
#define IME_CONFIG_SELECTDICTIONARY     3

/* dialog mode of ImmEscape */
#define IME_ESC_QUERY_SUPPORT           0x0003
#define IME_ESC_RESERVED_FIRST          0x0004
#define IME_ESC_RESERVED_LAST           0x07FF
#define IME_ESC_PRIVATE_FIRST           0x0800
#define IME_ESC_PRIVATE_LAST            0x0FFF
#define IME_ESC_SEQUENCE_TO_INTERNAL    0x1001
#define IME_ESC_GET_EUDC_DICTIONARY     0x1003
#define IME_ESC_SET_EUDC_DICTIONARY     0x1004
#define IME_ESC_MAX_KEY                 0x1005
#define IME_ESC_IME_NAME                0x1006
#define IME_ESC_SYNC_HOTKEY             0x1007
#define IME_ESC_HANJA_MODE              0x1008
#define IME_ESC_AUTOMATA                0x1009
#define IME_ESC_PRIVATE_HOTKEY          0x100A
#define IME_ESC_GETHELPFILENAME         0x100B

/* style of word registration */
#define IME_REGWORD_STYLE_EUDC          0x00000001
#define IME_REGWORD_STYLE_USER_FIRST    0x80000000
#define IME_REGWORD_STYLE_USER_LAST     0xFFFFFFFF

#if (WINVER >= 0x040A)

/* dwFlags for ImmAssociateContextEx */
#define IACE_CHILDREN           0x0001
#define IACE_DEFAULT            0x0010
#define IACE_IGNORENOCONTEXT    0x0020

/* dwFlags for ImmGetImeMenuItems */
#define IGIMIF_RIGHTMENU        0x0001

/* dwType for ImmGetImeMenuItems */
#define IGIMII_CMODE            0x0001
#define IGIMII_SMODE            0x0002
#define IGIMII_CONFIGURE        0x0004
#define IGIMII_TOOLS            0x0008
#define IGIMII_HELP             0x0010
#define IGIMII_OTHER            0x0020
#define IGIMII_INPUTTOOLS       0x0040

/* fType of IMEMENUITEMINFO structure */
#define IMFT_RADIOCHECK         0x00001
#define IMFT_SEPARATOR          0x00002
#define IMFT_SUBMENU            0x00004

/* fState of IMEMENUITEMINFO structure */
#define IMFS_GRAYED             MFS_GRAYED
#define IMFS_DISABLED           MFS_DISABLED
#define IMFS_CHECKED            MFS_CHECKED
#define IMFS_HILITE             MFS_HILITE
#define IMFS_ENABLED            MFS_ENABLED
#define IMFS_UNCHECKED          MFS_UNCHECKED
#define IMFS_UNHILITE           MFS_UNHILITE
#define IMFS_DEFAULT            MFS_DEFAULT

#endif /* WINVER >= 0x040A */

/* types of soft keyboard */
#define SOFTKEYBOARD_TYPE_T1    0x0001 /* for Tranditional Chinese */
#define SOFTKEYBOARD_TYPE_C1    0x0002 /* for Simplified Chinese */

HIMC WINAPI ImmAssociateContext(_In_ HWND hWnd, _In_opt_ HIMC hIMC);
#if (WINVER >= 0x040A)
BOOL WINAPI ImmAssociateContextEx(_In_ HWND hWnd, _In_opt_ HIMC hIMC, _In_ DWORD dwFlags);
#endif

BOOL WINAPI ImmConfigureIMEA(_In_ HKL hKL, _In_ HWND hWnd, _In_ DWORD dwMode, _Inout_opt_ LPVOID lpData);
BOOL WINAPI ImmConfigureIMEW(_In_ HKL hKL, _In_ HWND hWnd, _In_ DWORD dwMode, _Inout_opt_ LPVOID lpData);
HIMC WINAPI ImmCreateContext(VOID);
BOOL WINAPI ImmDestroyContext(_In_ HIMC hIMC);
#if (WINVER >= 0x040A)
BOOL WINAPI ImmDisableIME(_In_ DWORD idThread);
BOOL WINAPI ImmEnumInputContext(_In_ DWORD dwThreadId, _In_ IMCENUMPROC lpfn, _In_ LPARAM lParam);
#endif

UINT
WINAPI
ImmEnumRegisterWordA(
    _In_ HKL hKL,
    _In_ REGISTERWORDENUMPROCA lpfnEnumProc,
    _In_opt_ LPCSTR lpszReading,
    _In_ DWORD dwStyle,
    _In_opt_ LPCSTR lpszRegister,
    _Inout_opt_ LPVOID lpData);

UINT
WINAPI
ImmEnumRegisterWordW(
    _In_ HKL hKL,
    _In_ REGISTERWORDENUMPROCW lpfnEnumProc,
    _In_opt_ LPCWSTR lpszReading,
    _In_ DWORD dwStyle,
    _In_opt_ LPCWSTR lpszRegister,
    _Inout_opt_ LPVOID lpData);

LRESULT WINAPI
ImmEscapeA(
    _In_ HKL hKL,
    _In_ HIMC hIMC,
    _In_ UINT uSubFunc,
    _Inout_opt_ LPVOID lpData);

LRESULT WINAPI
ImmEscapeW(
    _In_ HKL hKL,
    _In_ HIMC hIMC,
    _In_ UINT uSubFunc,
    _Inout_opt_ LPVOID lpData);

DWORD
WINAPI
ImmGetCandidateListA(
    _In_ HIMC hIMC,
    _In_ DWORD deIndex,
    _Out_writes_bytes_opt_(dwBufLen) LPCANDIDATELIST lpCandList,
    _In_ DWORD dwBufLen);

DWORD
WINAPI
ImmGetCandidateListW(
    _In_ HIMC hIMC,
    _In_ DWORD deIndex,
    _Out_writes_bytes_opt_(dwBufLen) LPCANDIDATELIST lpCandList,
    _In_ DWORD dwBufLen);

DWORD WINAPI ImmGetCandidateListCountA(_In_ HIMC hIMC, _Out_ LPDWORD lpdwListCount);
DWORD WINAPI ImmGetCandidateListCountW(_In_ HIMC hIMC, _Out_ LPDWORD lpdwListCount);

BOOL
WINAPI
ImmGetCandidateWindow(
    _In_ HIMC hIMC,
    _In_ DWORD dwIndex,
    _Out_ LPCANDIDATEFORM lpCandidate);

#if defined(_WINGDI_) && !defined(NOGDI)

BOOL WINAPI ImmGetCompositionFontA(_In_ HIMC hIMC, _Out_ LPLOGFONTA lplf);
BOOL WINAPI ImmGetCompositionFontW(_In_ HIMC hIMC, _Out_ LPLOGFONTW lplf);

BOOL WINAPI ImmSetCompositionFontA(_In_ HIMC hIMC, _In_ LPLOGFONTA lplf);
BOOL WINAPI ImmSetCompositionFontW(_In_ HIMC hIMC, _In_ LPLOGFONTW lplf);

#ifdef UNICODE
    #define ImmGetCompositionFont ImmGetCompositionFontW
#else
    #define ImmGetCompositionFont ImmGetCompositionFontA
#endif

#endif

LONG
WINAPI
ImmGetCompositionStringA(
    _In_ HIMC hIMC,
    _In_ DWORD dwIndex,
    _Out_writes_bytes_opt_(dwBufLen) LPVOID lpBuf,
    _In_ DWORD dwBufLen);

LONG
WINAPI
ImmGetCompositionStringW(
    _In_ HIMC hIMC,
    _In_ DWORD dwIndex,
    _Out_writes_bytes_opt_(dwBufLen) LPVOID lpBuf,
    _In_ DWORD dwBufLen);

BOOL WINAPI ImmGetCompositionWindow(_In_ HIMC hIMC, _Out_ LPCOMPOSITIONFORM lpCompForm);
HIMC WINAPI ImmGetContext(_In_ HWND hWnd);

DWORD
WINAPI
ImmGetConversionListA(
    _In_ HKL hKL,
    _In_ HIMC hIMC,
    _In_ LPCSTR lpSrc,
    _Out_writes_bytes_(dwBufLen) LPCANDIDATELIST lpDst,
    _In_ DWORD dwBufLen,
    _In_ UINT uFlag);

DWORD
WINAPI
ImmGetConversionListW(
    _In_ HKL hKL,
    _In_ HIMC hIMC,
    _In_ LPCWSTR lpSrc,
    _Out_writes_bytes_(dwBufLen) LPCANDIDATELIST lpDst,
    _In_ DWORD dwBufLen,
    _In_ UINT uFlag);

BOOL
WINAPI
ImmGetConversionStatus(
    _In_ HIMC hIMC,
    _Out_opt_ LPDWORD lpfdwConversion,
    _Out_opt_ LPDWORD lpfdwSentence);

HWND WINAPI ImmGetDefaultIMEWnd(_In_opt_ HWND hWnd);

UINT
WINAPI
ImmGetDescriptionA(
    _In_ HKL hKL,
    _Out_writes_opt_(uBufLen) LPSTR lpszDescription,
    _In_ UINT uBufLen);

UINT
WINAPI
ImmGetDescriptionW(
    _In_ HKL hKL,
    _Out_writes_opt_(uBufLen) LPWSTR lpszDescription,
    _In_ UINT uBufLen);

DWORD
WINAPI
ImmGetGuideLineA(
    _In_ HIMC hIMC,
    _In_ DWORD dwIndex,
    _Out_writes_bytes_opt_(dwBufLen) LPSTR lpBuf,
    _In_ DWORD dwBufLen);

DWORD
WINAPI
ImmGetGuideLineW(
    _In_ HIMC hIMC,
    _In_ DWORD dwIndex,
    _Out_writes_bytes_opt_(dwBufLen) LPWSTR lpBuf,
    _In_ DWORD dwBufLen);

UINT
WINAPI
ImmGetIMEFileNameA(
    _In_ HKL hKL,
    _Out_writes_opt_(uBufLen) LPSTR lpszFileName,
    _In_ UINT uBufLen);

UINT
WINAPI
ImmGetIMEFileNameW(
    _In_ HKL hKL,
    _Out_writes_opt_(uBufLen) LPWSTR lpszFileName,
    _In_ UINT uBufLen);

#if (WINVER >= 0x040A)

DWORD
WINAPI
ImmGetImeMenuItemsA(
    _In_ HIMC hIMC,
    _In_ DWORD dwFlags,
    _In_ DWORD dwType,
    _Inout_opt_ LPIMEMENUITEMINFOA lpImeParentMenu,
    _Out_writes_bytes_opt_(dwSize) LPIMEMENUITEMINFOA lpImeMenu,
    _In_ DWORD dwSize);

DWORD
WINAPI
ImmGetImeMenuItemsW(
    _In_ HIMC hIMC,
    _In_ DWORD dwFlags,
    _In_ DWORD dwType,
    _Inout_opt_ LPIMEMENUITEMINFOW lpImeParentMenu,
    _Out_writes_bytes_opt_(dwSize) LPIMEMENUITEMINFOW lpImeMenu,
    _In_ DWORD dwSize);

#ifdef UNICODE
    #define ImmGetImeMenuItems ImmGetImeMenuItemsW
#else
    #define ImmGetImeMenuItems ImmGetImeMenuItemsA
#endif

#endif /* WINVER >= 0x040A */

BOOL WINAPI ImmGetOpenStatus(_In_ HIMC hIMC);
DWORD WINAPI ImmGetProperty(_In_ HKL hKL, _In_ DWORD fdwIndex);

UINT
WINAPI
ImmGetRegisterWordStyleA(
    _In_ HKL hKL,
    _In_ UINT nItem,
    _Out_writes_(nItem) LPSTYLEBUFA lpStyleBuf);

UINT
WINAPI
ImmGetRegisterWordStyleW(
    _In_ HKL hKL,
    _In_ UINT nItem,
    _Out_writes_(nItem) LPSTYLEBUFW lpStyleBuf);

BOOL WINAPI ImmGetStatusWindowPos(_In_ HIMC hIMC, _Out_ LPPOINT lpptPos);
UINT WINAPI ImmGetVirtualKey(_In_ HWND hWnd);

HKL WINAPI ImmInstallIMEA(_In_ LPCSTR lpszIMEFileName, _In_ LPCSTR lpszLayoutText);
HKL WINAPI ImmInstallIMEW(_In_ LPCWSTR lpszIMEFileName, _In_ LPCWSTR lpszLayoutText);

BOOL WINAPI ImmIsIME(_In_ HKL hKL);

BOOL WINAPI
ImmIsUIMessageA(
    _In_opt_ HWND hWndIME,
    _In_ UINT msg,
    _In_ WPARAM wParam,
    _In_ LPARAM lParam);

BOOL WINAPI
ImmIsUIMessageW(
    _In_opt_ HWND hWndIME,
    _In_ UINT msg,
    _In_ WPARAM wParam,
    _In_ LPARAM lParam);

BOOL WINAPI
ImmNotifyIME(
    _In_ HIMC hIMC,
    _In_ DWORD dwAction,
    _In_ DWORD dwIndex,
    _In_ DWORD_PTR dwValue);

BOOL
WINAPI
ImmRegisterWordA(
    _In_ HKL hKL,
    _In_opt_ LPCSTR lpszReading,
    _In_ DWORD dwStyle,
    _In_opt_ LPCSTR lpszRegister);

BOOL
WINAPI
ImmRegisterWordW(
    _In_ HKL hKL,
    _In_opt_ LPCWSTR lpszReading,
    _In_ DWORD dwStyle,
    _In_opt_ LPCWSTR lpszRegister);

BOOL WINAPI ImmReleaseContext(_In_ HWND hWnd, _In_ HIMC hIMC);
BOOL WINAPI ImmSetCandidateWindow(_In_ HIMC hIMC, _In_ LPCANDIDATEFORM lpCandidate);

BOOL
WINAPI
ImmSetCompositionStringA(
    _In_ HIMC hIMC,
    _In_ DWORD dwIndex,
    _Inout_updates_bytes_opt_(dwCompLen) LPVOID lpComp,
    _In_ DWORD dwCompLen,
    _Inout_updates_bytes_opt_(dwReadLen) LPVOID lpRead,
    _In_ DWORD dwReadLen);

BOOL
WINAPI
ImmSetCompositionStringW(
    _In_ HIMC hIMC,
    _In_ DWORD dwIndex,
    _Inout_updates_bytes_opt_(dwCompLen) LPVOID lpComp,
    _In_ DWORD dwCompLen,
    _Inout_updates_bytes_opt_(dwReadLen) LPVOID lpRead,
    _In_ DWORD dwReadLen);

BOOL WINAPI ImmSetCompositionWindow(_In_ HIMC hIMC, _In_ LPCOMPOSITIONFORM lpCompForm);

BOOL WINAPI
ImmSetConversionStatus(
    _In_ HIMC hIMC,
    _In_ DWORD fdwConversion,
    _In_ DWORD fdwSentence);

BOOL WINAPI ImmSetOpenStatus(_In_ HIMC hIMC, _In_ BOOL fOpen);
BOOL WINAPI ImmSetStatusWindowPos(_In_ HIMC hIMC, _In_ LPPOINT lpptPos);
BOOL WINAPI ImmSimulateHotKey(_In_ HWND hWnd, _In_ DWORD dwHotKeyID);

BOOL
WINAPI
ImmUnregisterWordA(
    _In_ HKL hKL,
    _In_opt_ LPCSTR lpszReading,
    _In_ DWORD dwStyle,
    _In_opt_ LPCSTR lpszUnregister);

BOOL
WINAPI
ImmUnregisterWordW(
    _In_ HKL hKL,
    _In_opt_ LPCWSTR lpszReading,
    _In_ DWORD dwStyle,
    _In_opt_ LPCWSTR lpszUnregister);

#ifdef UNICODE
    #define ImmConfigureIME ImmConfigureIMEW
    #define ImmEnumRegisterWord ImmEnumRegisterWordW
    #define ImmEscape ImmEscapeW
    #define ImmGetCandidateList ImmGetCandidateListW
    #define ImmGetCandidateListCount ImmGetCandidateListCountW
    #define ImmGetCompositionString ImmGetCompositionStringW
    #define ImmGetConversionList ImmGetConversionListW
    #define ImmGetDescription ImmGetDescriptionW
    #define ImmGetGuideLine ImmGetGuideLineW
    #define ImmGetIMEFileName ImmGetIMEFileNameW
    #define ImmGetRegisterWordStyle ImmGetRegisterWordStyleW
    #define ImmInstallIME ImmInstallIMEW
    #define ImmIsUIMessage ImmIsUIMessageW
    #define ImmRegisterWord ImmRegisterWordW
    #define ImmSetCompositionFont ImmSetCompositionFontW
    #define ImmSetCompositionString ImmSetCompositionStringW
    #define ImmUnregisterWord ImmUnregisterWordW
    typedef LPSTYLEBUFW LPSTYLEBUF;
    typedef NPSTYLEBUFW NPSTYLEBUF;
    typedef PSTYLEBUFW PSTYLEBUF;
    typedef REGISTERWORDENUMPROCW REGISTERWORDENUMPROC;
    typedef STYLEBUFW STYLEBUF;
#else
    #define ImmConfigureIME ImmConfigureIMEA
    #define ImmEnumRegisterWord ImmEnumRegisterWordA
    #define ImmEscape ImmEscapeA
    #define ImmGetCandidateList ImmGetCandidateListA
    #define ImmGetCandidateListCount ImmGetCandidateListCountA
    #define ImmGetCompositionString ImmGetCompositionStringA
    #define ImmGetConversionList ImmGetConversionListA
    #define ImmGetDescription ImmGetDescriptionA
    #define ImmGetGuideLine ImmGetGuideLineA
    #define ImmGetIMEFileName ImmGetIMEFileNameA
    #define ImmGetRegisterWordStyle ImmGetRegisterWordStyleA
    #define ImmInstallIME ImmInstallIMEA
    #define ImmIsUIMessage ImmIsUIMessageA
    #define ImmRegisterWord ImmRegisterWordA
    #define ImmSetCompositionFont ImmSetCompositionFontA
    #define ImmSetCompositionString ImmSetCompositionStringA
    #define ImmUnregisterWord ImmUnregisterWordA
    typedef LPSTYLEBUFA LPSTYLEBUF;
    typedef NPSTYLEBUFA NPSTYLEBUF;
    typedef PSTYLEBUFA PSTYLEBUF;
    typedef REGISTERWORDENUMPROCA REGISTERWORDENUMPROC;
    typedef STYLEBUFA STYLEBUF;
#endif

#ifdef __cplusplus
}
#endif

#endif  /* __WINE_IMM_H */
